

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

<html>
<head>
<script type="text/javascript" src="helpman_topicinit.js"></script>

<title>Tagged Value Macros [Enterprise Architect User Guide]</title>

<meta name="keywords" content="Enterprise Architect, Sparx Systems, UML, Tagged Value,Tagged Value Macros, Code Template Syntax,Macro,Macro Tagged Value, Code Template Syntax">
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
<meta http-equiv="Content-Style-Type" content="text/css" />

<link type="text/css" href="default.css" rel="stylesheet" />
<style type="text/css">
  A, A:Visited
  {
    color: #00F;
  }

  A:Active, A:Hover
  {
    color: #F00;
  }

  OL
  {
    margin: 5px 0 5px 48px;
  }

  UL
  {
    margin-bottom: 3px;
    margin-top: 0;
  }

  #nsr
  {
    background-color: #D4DFFF;
  }

  #nsr A
  {
    text-decoration: none;
  }

  #mainbody
  {
    padding: 8px;
  }

  .p_BodyText
  {
    padding: 5px 0;
  }
</style>



<style type="text/css" media="screen">
  BODY
  {
    background-color: #FFFFFF;
  }

  #nsr
  {
    padding: 6px 6px 0 6px;
    border-bottom: none;
    vertical-align: top;
    z-index: 2;
    visibility: visible;
    left: 0;
    top: 0;
    position: absolute;
  }

  #mainbody
  {
    left: 0;
    top: 0;
    margin: 0;
    position: absolute;
    padding: 10px;
    overflow: auto;
    height: 100%;
    z-index: 1;
    background-repeat: no-repeat;
    background-position: bottom right;
    background-attachment: fixed;
  }
</style>

<style type="text/css" media="print">
  #nsr
  {
    visibility: none;
  }

  #mainbody
  {
    overflow: visible;
  }
</style>
<script type="text/javascript" language="JavaScript" src="nonscroll.js"></script>

</head>
<body scroll="no">

<div id="page">



        <div id="content">
          <div id="content-inner">
          



  
          <div id="nsr">
            <table border="0" cellspacing="0" cellpadding="4" width="100%">
              <tr valign="top">
                <td align="left">
  


                  <p class="p_Heading1"><span class="f_Heading1">Tagged Value Macros</span></p>



  
                </td>
                <td align="right">
                  <a href="introduction.htm" onmouseover="document.images.main.src='button_main_h.gif'" onmouseout="document.images.main.src='button_main.gif'">
                    <img name="main" src="button_main.gif" border=0 alt="Return to Introduction">
                  </a>&nbsp;
    
                  <a href="fieldsubstitutionmacros.htm" onmouseover="document.images.prev.src='button_prev_h.gif'" onmouseout="document.images.prev.src='button_prev.gif'">
                    <img name=prev src="button_prev.gif" border=0 alt="Previous page" />
                  </a>&nbsp;
    
    
    
                  <a href="functionmacros.htm" onmouseover="document.images.next.src='button_next_h.gif'" onmouseout="document.images.next.src='button_next.gif'">
                    <img name=next src="button_next.gif" border=0 alt="Next page" />
                  </a>
    
    
                </td>
              </tr>
            </table>
          </div>
          <div id="mainbody">
  


                <p class="p_BodyText"><span class="f_BodyText" style="font-style: italic;">Tagged Value</span><span class="f_BodyText"> macros are a special form of field substitution macros, which provide access to element tags and the corresponding Tagged Values.</span></p>
<p class="p_SubHeadingL1"><span class="f_SubHeadingL1">Use 1: Direct Substitution</span></p>
<p class="p_BodyText"><span class="f_BodyText">This form of the macro directly substitutes the value of the named tag into the output.</span></p>
<p class="p_BodyText"><span class="f_BodyText">Structure: </span><span class="f_Code">%&lt;macroName&gt;:&quot;&lt;tagName&gt;&quot;% </span></p>
<p class="p_BodyText"><span class="f_BodyText">&lt;</span><span class="f_BodyText" style="font-style: italic;">macroName</span><span class="f_BodyText">&gt; can be one of:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">attTag</span></li>
<li><span class="f_Bulletlist1">classTag</span></li>
<li><span class="f_Bulletlist1">connectorDestTag</span></li>
<li><span class="f_Bulletlist1">connectorSourceTag</span></li>
<li><span class="f_Bulletlist1">connectorTag</span></li>
<li><span class="f_Bulletlist1">linkAttTag</span></li>
<li><span class="f_Bulletlist1">linkTag</span></li>
<li><span class="f_Bulletlist1">opTag</span></li>
<li><span class="f_Bulletlist1">packageTag</span></li>
<li><span class="f_Bulletlist1">paramTag</span></li>
</ul>
<p class="p_BodyText"><span class="f_BodyText">This corresponds to the tags for attributes, Classes, operations, packages, parameters, connectors with both ends and connectors including the attribute end respectively.</span></p>
<p class="p_BodyText"><span class="f_BodyText">&lt;</span><span class="f_BodyText" style="font-style: italic;">tagName</span><span class="f_BodyText">&gt; is a string representing the specific tag name.</span></p>
<p class="p_SubHeadingL2"><span class="f_SubHeadingL2">Examples:</span></p>
<p class="p_Code"><span class="f_Code">%opTag:&quot;attribute&quot;%</span></p>
<p class="p_SubHeadingL1"><span class="f_SubHeadingL1">Use 2: Conditional Substitution</span></p>
<p class="p_BodyText"><span class="f_BodyText">This form of the macro mimics the conditional substitution defined for field substitution macros.</span></p>
<p class="p_BodyText"><span class="f_BodyText">Structure: </span><span class="f_Code">%&lt;macroName&gt;:&quot;&lt;tagName&gt;&quot; [ == &quot;&lt;test&gt;&quot;] ? &lt;subTrue&gt; [ : &lt;subFalse&gt; ]%</span></p>
<p class="p_BodyText"><span class="f_BodyText">Where:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">&lt;</span><span class="f_Bulletlist1" style="font-style: italic;">macroName</span><span class="f_Bulletlist1">&gt; and &lt;</span><span class="f_Bulletlist1" style="font-style: italic;">tagName</span><span class="f_Bulletlist1">&gt; are as defined above</span></li>
<li><span class="f_Bulletlist1">[ &lt;</span><span class="f_Bulletlist1" style="font-style: italic;">text</span><span class="f_Bulletlist1">&gt; ] denotes that &lt;text&gt; is optional</span></li>
<li><span class="f_Bulletlist1" style="font-style: italic;">&lt;test&gt;</span><span class="f_Bulletlist1"> is a string representing a possible value for the macro</span></li>
<li><span class="f_Bulletlist1">&lt;</span><span class="f_Bulletlist1" style="font-style: italic;">subTrue</span><span class="f_Bulletlist1">&gt; and &lt;</span><span class="f_Bulletlist1" style="font-style: italic;">subFalse</span><span class="f_Bulletlist1">&gt; can be a combination of quoted strings and the keyword value. Where the value is used, it gets replaced with the macro's value in the output.</span></li>
</ul>
<p class="p_SubHeadingL2"><span class="f_SubHeadingL2">Examples:</span></p>
<p class="p_Code"><span class="f_Code">%opTag:&quot;opInline&quot; ? &quot;inline&quot; : &quot;&quot;%</span></p>
<p class="p_Code"><span class="f_Code">%opTag:&quot;opInline&quot; ? &quot;inline&quot;%</span></p>
<p class="p_Code"><span class="f_Code">%classTag:&quot;unsafe&quot; == &quot;true&quot; ? &quot;unsafe&quot; : &quot;&quot;%</span></p>
<p class="p_Code"><span class="f_Code">%classTag:&quot;unsafe&quot; == &quot;true&quot; ? &quot;unsafe&quot;%</span></p>
<p class="p_BodyText"><span class="f_BodyText">Tagged Value macros use the same naming convention as field substitution macros.</span></p>




            </div>
          </div>
        </div>



</div>


</body>
</html>
